MarkLogic 9 Product Documentation
GET /manage/v2/privileges/{id|name}/properties

Summary

This resource address returns the properties of the specified privilege.

URL Parameters
format The format of the returned data. Can be either json or xml (default). This value overrides the Accept header if both are present.
kind The kind of privilege. Can be either execute or uri.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges. A status code of 404 (no such user) is returned if the user does not exist.

Required Privileges

This operation requires the security and manage-admin roles.

Usage Notes

The structure of the output returned from this REST API is as follows:

privilege-name

Privilege name (unique)

action

A URI to protect.

kind

A protected "action" (or object).

roles

The roles assigned. The roles assigned to the user.

This is a complex structure with the following children:

role

A role identifier (unique key).

Example


http://localhost:8002/manage/v2/privileges/engineer-execute/properties

==> Returns the properties of the privilege, "engineer-execute," 
    from the Security database.
Powered by MarkLogic Server | Terms of Use | Privacy Policy